services/friendbot: Instrument friendbot to emit traces #5796

satyamz · 2025-08-22T13:06:44Z

PR Checklist

PR Structure

This PR has reasonably narrow scope (if not, break it down into smaller PRs).
This PR avoids mixing refactoring changes with feature changes (split into two PRs
otherwise).
This PR's title starts with name of package that is most changed in the PR, ex.
services/friendbot, or all or doc if the changes are broad or impact many
packages.

Thoroughness

This PR adds tests for the most critical parts of the new functionality or fixes.
I've updated any docs (developer docs, .md
files, etc... affected by this change). Take a look in the docs folder for a given service,
like this one.

Release planning

I've reviewed the changes in this PR and if I consider them worthwhile for being mentioned on release notes then I have updated the relevant CHANGELOG.md within the component folder structure. For example, if I changed horizon, then I updated (services/horizon/CHANGELOG.md. I add a new line item describing the change and reference to this PR. If I don't update a CHANGELOG, I acknowledge this PR's change may not be mentioned in future release notes.
I've decided if this PR requires a new major/minor version according to
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.

What

services/friendbot: Instrument friendbot to emit traces. Traces will be sent to Grafana alloy which will send traces to Grafana tempo.

Trace looks like this in Grafana tempo:

Why

We want to have an ability track request lifecycle
Help identify performance bottlenecks.

Known limitations

This PR updates several dependencies. We need land this carefully.

Issue:

https://github.com/stellar/ops/issues/4005

socket-security · 2025-08-22T13:08:46Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	golang/github.com/go-chi/chi/v5@v5.1.0
	golang/go.opentelemetry.io/otel@v1.28.0 ⏵ v1.34.0	⁺¹
	golang/github.com/stretchr/testify@v1.9.0 ⏵ v1.10.0	⁺¹
	golang/go.opentelemetry.io/otel/sdk@v1.28.0 ⏵ v1.34.0	⁺¹
	golang/github.com/riandyrn/otelchi@v0.12.1
	golang/go.opentelemetry.io/otel/trace@v1.28.0 ⏵ v1.34.0	⁺¹

View full report

Copilot

Pull Request Overview

This PR instruments the friendbot service to emit OpenTelemetry traces that will be sent to Grafana Alloy and forwarded to Grafana Tempo for distributed tracing capabilities and performance monitoring.

Added a new utils/tracer package with OpenTelemetry configuration
Updated friendbot service to use context-aware tracing throughout the request lifecycle
Added OpenTelemetry middleware to the HTTP router for automatic request tracing

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
utils/tracer/tracer.go	New utility package for OpenTelemetry tracer initialization and configuration
services/friendbot/main.go	Updated to initialize tracing, add OpenTelemetry middleware, and use chi/v5 router
services/friendbot/internal/friendbot_handler.go	Added tracing instrumentation to HTTP request handlers
services/friendbot/internal/friendbot.go	Updated Pay method to accept context for tracing
services/friendbot/internal/minion.go	Added context parameter and span instrumentation to minion operations
services/friendbot/internal/minion_test.go	Updated test functions to pass context parameter
services/friendbot/internal/friendbot_test.go	Updated test functions to pass context parameter
services/friendbot/friendbot.cfg	Added otel_endpoint configuration
go.mod	Updated dependencies to include OpenTelemetry packages and chi/v5

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

utils/tracer/tracer.go

services/friendbot/main.go

services/friendbot/internal/friendbot_handler.go

satyamz · 2025-09-18T11:25:48Z

I am fixing the internal package tests.

leighmcculloch

Few comments inline.

services/friendbot/friendbot.cfg

services/friendbot/internal/friendbot.go

services/friendbot/internal/friendbot_test.go

services/friendbot/internal/minion.go

services/friendbot/main.go

utils/tracer/tracer.go

leighmcculloch · 2025-09-24T03:01:30Z

Before merging can you check that this will still function okay with quickstart? You can do that by building quickstart with the friendbot git ref pointing at your friendbot pr commit sha.

services/friendbot/internal/friendbot_test.go

services/friendbot/internal/minion.go

services/friendbot/main.go

Signed-off-by: Satyam Zode <[email protected]>

Co-authored-by: Copilot <[email protected]>

Signed-off-by: Satyam Zode <[email protected]>

leighmcculloch

Lgtm.

It does look like there are 10 alerts from the golintci run which should probably be addressed. It's erroring saying that the import is not specified in a depguard config. But there's no depguard config in this repo.

Depguard is enabled here:

go/.golangci.yml

Line 6 in 0e7db2c

- depguard

But I don't see any config for it. @tamirms @Shaptic does @satyamz need to add a depguard config with this import, or should we remove depguard if it isn't really in use?

Also, sharing this information in case it's tribal knowledge, but after merging, use Jenkins to escalate the release to prod, and then monitor the new versions to make sure it's working smoothly. You can try out friendbot hitting the URL directly or using the lab.stellar.org account create/funder to test it.

tamirms · 2025-10-09T12:43:57Z

@leighmcculloch I don't think depgaurd is used anywhere so we can remove it.

satyamz · 2025-10-13T12:52:54Z

Team, Can we merge this if it looks good?

satyamz marked this pull request as ready for review September 10, 2025 14:47

Copilot AI review requested due to automatic review settings September 10, 2025 14:47

Copilot AI reviewed Sep 10, 2025

View reviewed changes

utils/tracer/tracer.go Outdated Show resolved Hide resolved

services/friendbot/main.go Outdated Show resolved Hide resolved

services/friendbot/main.go Outdated Show resolved Hide resolved

services/friendbot/internal/friendbot_handler.go Show resolved Hide resolved

satyamz force-pushed the friendbot-instrumentation-03 branch from a0dded9 to 873e3fa Compare September 18, 2025 11:42

leighmcculloch reviewed Sep 24, 2025

View reviewed changes

satyamz force-pushed the friendbot-instrumentation-03 branch from 16efad5 to 65ba471 Compare September 25, 2025 11:26

leighmcculloch reviewed Oct 1, 2025

View reviewed changes

services/friendbot/internal/friendbot_test.go Outdated Show resolved Hide resolved

services/friendbot/internal/minion.go Outdated Show resolved Hide resolved

services/friendbot/main.go Outdated Show resolved Hide resolved

satyamz and others added 15 commits October 1, 2025 20:43

Add stellar tracer to utils package

dd4613e

Signed-off-by: Satyam Zode <[email protected]>

Add otelchi middleware for the go-chi middle

d844cd6

Signed-off-by: Satyam Zode <[email protected]>

Update go-chi package version

1710eb8

Signed-off-by: Satyam Zode <[email protected]>

Add instrumentation for friendbot handler function

c43ef69

Signed-off-by: Satyam Zode <[email protected]>

Add insecure flag for exporter

12d1a91

Signed-off-by: Satyam Zode <[email protected]>

Use handler with tracer

0a6b3b4

Signed-off-by: Satyam Zode <[email protected]>

Update instrumentation for friendbot

a1fbcc9

Signed-off-by: Satyam Zode <[email protected]>

Update utils/tracer/tracer.go

e233146

Co-authored-by: Copilot <[email protected]>

Update services/friendbot/main.go

fa8162c

Co-authored-by: Copilot <[email protected]>

Remove TODO from version

446c59c

Signed-off-by: Satyam Zode <[email protected]>

Add condition if tx is not success

139d73c

Signed-off-by: Satyam Zode <[email protected]>

Update friendbot package with otel modifications

6b95c11

Signed-off-by: Satyam Zode <[email protected]>

Remove t.context until go 1.24

5eefe39

Signed-off-by: Satyam Zode <[email protected]>

Remove t.context from tests

efefde8

Signed-off-by: Satyam Zode <[email protected]>

Update context handling in tests and remove mux params

8eb2292

Signed-off-by: Satyam Zode <[email protected]>

satyamz force-pushed the friendbot-instrumentation-03 branch from 46fc1de to 8eb2292 Compare October 1, 2025 15:19

satyamz and others added 2 commits October 1, 2025 20:50

Update tracer name in friendbot minion

9194d20

Signed-off-by: Satyam Zode <[email protected]>

Merge branch 'master' into friendbot-instrumentation-03

34bd2c8

leighmcculloch approved these changes Oct 7, 2025

View reviewed changes

Merge branch 'master' into friendbot-instrumentation-03

d973507

tamirms approved these changes Oct 9, 2025

View reviewed changes

Merge branch 'master' into friendbot-instrumentation-03

3d5f28e

leighmcculloch merged commit dd6ce8e into stellar:master Oct 14, 2025
20 checks passed

services/friendbot: Instrument friendbot to emit traces #5796

services/friendbot: Instrument friendbot to emit traces #5796

Uh oh!

Conversation

satyamz commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Structure

Thoroughness

Release planning

What

Why

Known limitations

Issue:

Uh oh!

socket-security bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

satyamz commented Sep 18, 2025

Uh oh!

leighmcculloch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leighmcculloch commented Sep 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leighmcculloch left a comment

Choose a reason for hiding this comment

Uh oh!

tamirms commented Oct 9, 2025

Uh oh!

satyamz commented Oct 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

satyamz commented Aug 22, 2025 •

edited

Loading

socket-security bot commented Aug 22, 2025 •

edited

Loading